infra: move app-architecture to getting-started + copy portal images#257
Open
marc0olo wants to merge 4 commits into
Open
infra: move app-architecture to getting-started + copy portal images#257marc0olo wants to merge 4 commits into
marc0olo wants to merge 4 commits into
Conversation
Move docs/concepts/app-architecture.md → docs/getting-started/app-architecture.md (order 3, between project-structure and choose-your-path) so new developers encounter architectural patterns before picking a development track. Update sidebar.mjs, fix all inbound links, and adjust choose-your-path to order 4. Copy 13 concept/architecture diagrams from portal that have not yet been migrated. Images are staged in public/ directories co-located with the pages that will use them; embedding is left for follow-up once each image is reviewed. Skipped: UI screenshots, blog images, and tutorial step-by-step captures (no doc-page home, change too fast).
|
🤖 Here's your preview: https://uc7il-jaaaa-aaaam-ai2gq-cai.icp0.io |
Add the five images that add genuine visual clarity to concept pages: - app-arch.png → app-architecture.md (two-canister model overview) - inside-canister.png → canisters.md (canister components diagram) - key_derivation.png → chain-key-cryptography.md (BIP-32 derivation hierarchy) - vetkd_diagram.png → vetkeys.md (protocol flow) - vetkd_derivation.png → vetkeys.md (key hierarchy) Remove sdk-protocol-local-overview.svg and sdk-protocol-network.svg: not referenced in any portal docs page and reference dfx toolchain concepts. Remaining staged images (not yet embedded): app-flow.png, call-canister.png, ingress_async_call.png, ingress_sync_call.png, retry_idempotency.png, transaction-overview.svg — see PR description for placement plan.
Drop five images that turned out to be redundant or without a page: - retry_idempotency.png: idempotency.md already has a native PlantUML diagram - ingress_async_call.png + ingress_sync_call.png: https-interface.md already covers both patterns with a PlantUML state diagram and full prose; these would duplicate content in a worse format - transaction-overview.svg: no matching page (was cycles cost formulas in portal) - app-flow.png: redundant with app-arch.png already embedded in app-architecture.md Remaining staged image: public/concepts/canisters/call-canister.png Candidate home: calling-from-clients.md "Query vs update calls" section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Move
app-architecture.mdto Getting Started (order 3, between Project structure and Choose your path): this is a first-day architectural decision, not a deep-dive concept. Moving it here means every new developer encounters it right after they understand the project files and before they pick a track. All inbound links and the sidebar config are updated.Embed 5 concept diagrams ported from the portal, each evaluated against the portal source context and the current content of the target page.
Embedded images
app-arch.pnggetting-started/app-architecture.mdinside-canister.pngconcepts/canisters.mdkey_derivation.pngconcepts/chain-key-cryptography.mdvetkd_diagram.pngconcepts/vetkeys.mdvetkd_derivation.pngconcepts/vetkeys.mdImages not ported and why
call-canister.pngcalling-from-clients.mdretry_idempotency.pngidempotency.mdalready has a native PlantUML diagram covering the exact same retry loopingress_async_call.png,ingress_sync_call.pnghttps-interface.mdalready covers both patterns with a PlantUML state diagram and full prosetransaction-overview.svgapp-flow.pngapp-arch.pngalready embeddedsdk-protocol-local-overview.svg,sdk-protocol-network.svgii_mobile_delegation_chain.pngalready in developer-docscreate-canister.png,install-canister.pngcanister.pngpublic/concepts/imagesvcs-1..4.pngCandid-xrc.pngckbtc-overview.pngpublic/concepts/chain-fusion/ckbtc-architecture.pngSync recommendation
docs/getting-started/app-architecture.md—informed by dfinity/portal docs/building-apps/best-practices/application-architectures.mdx, docs/building-apps/getting-started/app-architecture.mdxImages: copied from
dfinity/portal static/img/docs/anddocs/*/_attachments/.